package exceptions;

import be.kuleuven.cs.som.annotate.Basic;

/**
 * A class for signaling illegal coordinates for the robots.
 * @version  1.0
 * @author   Lies Tambeur & Eline Vanrykel
 */
public class IllegalCoordException extends Exception{
	
	/**
	 * Variable registering the value involved in this illegal coordinates
	 * exception.
	 */
	private final long value;
	
	/**
	 * The Java API strongly recommends to explicitly define a version
	 * number for classes that implement the interface Serializable.
	 * At this stage, that aspect is of no concern to us. 
	 */
	private static final long serialVersionUID = 1L;
	
	/**
	 * Initialize this new illegal coordinates exception with given value.
	 * 
	 * @param  	value
	 *         	The value for this new illegal coordinates exception.
	 * @post   	The value of this new illegal coordinates exception is equal
	 *         	to the given value.
	 *       	| new.getValue() == value
	 */
	public IllegalCoordException(long value){
		this.value=value;
	}

	/**
	 * Return the value registered for this illegal coordinates exception.
	 */
	@Basic 
	public long getValue(){
		return this.value;
	}

}
